home *** CD-ROM | disk | FTP | other *** search
/ MacWorld 2003 August / MW 8 2003 CD1.iso / Inside Macworld / Product News / gimp-1.2.4.sit / gimp-1.2.4 / devel-docs / libgimp / sgml / gimphelp.sgml < prev    next >
Encoding:
Text File  |  2003-05-20  |  2.1 KB  |  74 lines
  1. <refentry id="libgimp-gimphelp" revision="19 Jan 2001">
  2. <refmeta>
  3. <refentrytitle>gimphelp</refentrytitle>
  4. <manvolnum>3</manvolnum>
  5. <refmiscinfo>LIBGIMP Library</refmiscinfo>
  6. </refmeta>
  7.  
  8. <refnamediv>
  9. <refname>gimphelp</refname><refpurpose></refpurpose>
  10. </refnamediv>
  11.  
  12. <refsynopsisdiv><title>Synopsis</title>
  13. <synopsis>
  14.  
  15.  
  16.  
  17. <link linkend="gboolean">gboolean</link>    <link linkend="gimp-help">gimp_help</link>                       (<link linkend="gchar">gchar</link> *prog_name,
  18.                                              <link linkend="gchar">gchar</link> *help_page);
  19. </synopsis>
  20. </refsynopsisdiv>
  21.  
  22.  
  23.  
  24.  
  25.  
  26. <refsect1>
  27. <title>Description</title>
  28. <para>
  29.  
  30. </para>
  31. </refsect1>
  32.  
  33. <refsect1>
  34. <title>Details</title>
  35. <refsect2>
  36. <title><anchor id="gimp-help">gimp_help ()</title>
  37. <programlisting><link linkend="gboolean">gboolean</link>    gimp_help                       (<link linkend="gchar">gchar</link> *prog_name,
  38.                                              <link linkend="gchar">gchar</link> *help_page);</programlisting>
  39. <para>
  40. Load a help page.
  41. </para>
  42. <para>
  43. This procedure loads the specified help page into the helpbrowser or
  44. what ever is configured as help viewer. The location of the help
  45. page is given relative to the help rootdir. The help rootdir is
  46. determined from the prog_name: if prog_name is NULL, we use the help
  47. rootdir of the main GIMP installation, if the plug-in's full
  48. executable name is passed as prog_name, the GIMP will use this
  49. information to look up the help path the plug-in has registered
  50. before with gimp-plugin-help-register.</para>
  51. <para>
  52.  
  53. </para><informaltable pgwide=1 frame="none" role="params">
  54. <tgroup cols="2">
  55. <colspec colwidth="2*">
  56. <colspec colwidth="8*">
  57. <tbody>
  58. <row><entry align="right"><parameter>prog_name</parameter> :</entry>
  59. <entry> The plug-in's executable name or an empty string.
  60. </entry></row>
  61. <row><entry align="right"><parameter>help_page</parameter> :</entry>
  62. <entry> The location of the help page.
  63. </entry></row>
  64. <row><entry align="right"><emphasis>Returns</emphasis> :</entry><entry> TRUE on success.
  65. </entry></row>
  66. </tbody></tgroup></informaltable></refsect2>
  67.  
  68. </refsect1>
  69.  
  70.  
  71.  
  72.  
  73. </refentry>
  74.